Documentation: Add README file about how artifacts version is set in the pipeline #9148
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mary-georgiou-sonarsource
force-pushed
the
mary/doc-versioning
branch
6 times, most recently
from
b63a7cb
to
e0e675e
Compare
mary-georgiou-sonarsource
changed the title
mary-georgiou-sonarsource
changed the title
github-actions
bot
assigned pavel-mikula-sonarsource and unassigned mary-georgiou-sonarsource
|
pavel-mikula-sonarsource
requested changes
Apr 23, 2024
github-actions
bot
assigned mary-georgiou-sonarsource and unassigned pavel-mikula-sonarsource
mary-georgiou-sonarsource
force-pushed
the
mary/doc-versioning
branch
10 times, most recently
from
23b02ec
to
a4b1802
Compare
mary-georgiou-sonarsource
force-pushed
the
mary/doc-versioning
branch
2 times, most recently
from
502af83
to
6a1a3c0
Compare
github-actions
bot
assigned pavel-mikula-sonarsource and unassigned mary-georgiou-sonarsource
pavel-mikula-sonarsource
requested changes
May 17, 2024
github-actions
bot
assigned mary-georgiou-sonarsource and unassigned pavel-mikula-sonarsource
mary-georgiou-sonarsource
force-pushed
the
mary/doc-versioning
branch
3 times, most recently
from
0bf4c9e
to
c892851
Compare
github-actions
bot
assigned pavel-mikula-sonarsource and unassigned mary-georgiou-sonarsource
pavel-mikula-sonarsource
approved these changes
May 28, 2024
scripts/version/README.md
Outdated
|
|
||
| To set the version locally we run the [`set-version.ps1`](./set-version.ps1) script, which uses the `mvn set:version` command to update the java plugin's semantic version and the `ChangeVersion.proj` to update the analyzers' semantic version. Later, the `ChangeVersion.proj` and the `mvn set:version` (via the [`update-maven-version-steps.yml`](https://dev.azure.com/sonarsource/DotNetTeam%20Project/_git/pipelines-yaml-templates?path=/update-maven-version-steps.yml&version=GBmaster&line=20&lineEnd=21&lineStartColumn=1&lineEndColumn=1&lineStyle=plain&_a=contents)) are called in the pipeline to update the build version of the artifacts. | ||
|
|
||
| ## 1. How version is set in *.jar artifacts |
There was a problem hiding this comment.
I don't like the numbers. They are hard to maintain to keep them consistent and we don't really need them.
Suggested change
| ## 1. How version is set in *.jar artifacts | |
| ## How version is set in *.jar artifacts |
scripts/version/README.md
Outdated
|
|
||
| ## 3. Notes | ||
|
|
||
| What is important to keep is that the versions in the root pom.xml, and the [MainVersion field](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) in the `Version.props` must |
There was a problem hiding this comment.
Suggested change
| What is important to keep is that the versions in the root pom.xml, and the [MainVersion field](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) in the `Version.props` must | |
| What is important to keep is that the versions in the root pom.xml, and the [MainVersion](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) field in the `Version.props` must |
scripts/version/README.md
Outdated
| 1. [SonarAnalyzer.CSharp.Styling.nuspec](../../analyzers/packaging/SonarAnalyzer.CSharp.Styling.nuspec) | ||
| 1. [AssemblyInfo.Shared.cs](../../analyzers/src/AssemblyInfo.Shared.cs) | ||
|
|
||
| However, during the sonar-dotnet pipeline run, the files 2-6 above, have any reference to the semantic version replaced by the value in the [MainVersion field](https://github.com/SonarSource/sonar-dotnet/blob/a998f32eac72c7b6b4562935ffb8d423c6ebf936/scripts/version/Version.props#L3) of the `Version.props` file. This happens during the build of the [`ChangeVersion.proj`](./ChangeVersion.proj) that is [executed in the pipeline](https://github.com/SonarSource/sonar-dotnet/blob/master/azure-pipelines.yml#L91). |
There was a problem hiding this comment.
The pipeline #L91 needs a fixed commit. Otherwise it will go out of sync with very next pipeline change
scripts/version/README.md
Outdated
| 1. [SonarAnalyzer.CSharp.Styling.nuspec](../../analyzers/packaging/SonarAnalyzer.CSharp.Styling.nuspec) | ||
| 1. [AssemblyInfo.Shared.cs](../../analyzers/src/AssemblyInfo.Shared.cs) | ||
|
|
||
| However, during the sonar-dotnet pipeline run, the files 2-6 above, have any reference to the semantic version replaced by the value in the [MainVersion field](https://github.com/SonarSource/sonar-dotnet/blob/a998f32eac72c7b6b4562935ffb8d423c6ebf936/scripts/version/Version.props#L3) of the `Version.props` file. This happens during the build of the [`ChangeVersion.proj`](./ChangeVersion.proj) that is [executed in the pipeline](https://github.com/SonarSource/sonar-dotnet/blob/master/azure-pipelines.yml#L91). |
There was a problem hiding this comment.
Suggested change
| However, during the sonar-dotnet pipeline run, the files 2-6 above, have any reference to the semantic version replaced by the value in the [MainVersion field](https://github.com/SonarSource/sonar-dotnet/blob/a998f32eac72c7b6b4562935ffb8d423c6ebf936/scripts/version/Version.props#L3) of the `Version.props` file. This happens during the build of the [`ChangeVersion.proj`](./ChangeVersion.proj) that is [executed in the pipeline](https://github.com/SonarSource/sonar-dotnet/blob/master/azure-pipelines.yml#L91). | |
| However, during the sonar-dotnet pipeline run, the files 2-6 above, have any reference to the semantic version replaced by the value in the [MainVersion](https://github.com/SonarSource/sonar-dotnet/blob/a998f32eac72c7b6b4562935ffb8d423c6ebf936/scripts/version/Version.props#L3) field of the `Version.props` file. This happens during the build of the [`ChangeVersion.proj`](./ChangeVersion.proj) that is [executed in the pipeline](https://github.com/SonarSource/sonar-dotnet/blob/master/azure-pipelines.yml#L91). |
github-actions
bot
assigned mary-georgiou-sonarsource and unassigned pavel-mikula-sonarsource
mary-georgiou-sonarsource
force-pushed
the
mary/doc-versioning
branch
from
29e39db
to
e4ab709
Compare
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.